DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.17.1 StructureDefinition: DAF-Patient

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-patient

Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.17.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Patient.

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Patient
... identifier S1..*Identifier
.... type S0..1CodeableConceptDescription of identifier
.... system S1..1uri
.... value S1..1stringThe value that is unique within the system.
... active S0..1boolean
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S0..1code
... gender S0..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S I1..1stringinv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConcept
... multipleBirth[x] S0..1boolean, integer
... contact S0..*BackboneElement
.... relationship S0..*CodeableConceptBinding: PatientContactRelationship (required)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1code
..... line S0..*string
..... city S0..1string
..... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
..... postalCode S I0..1stringinv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1stringISO 3166 2 or 3 letter Country Code
Binding: ISO Country Codes (required)
... animal 0..0
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... careProvider S0..*Reference(DAF-Organization | DAF-Pract)
... managingOrganization S0..1Reference(DAF-Organization)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Slice: Unordered, Open, by url
Binding: MU Race Value Set (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-mothersMaidenName S0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
... us-core-religion S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-mothersMaidenName S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..*IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type S ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringThe value that is unique within the system.
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?! S∑0..1booleanWhether this patient's record is in active use
... name S ∑0..*HumanNameA name associated with the patient
... telecom S ∑0..*ContactPointA contact detail for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! S∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S ∑0..1dateThe date of birth for the individual
... deceased[x] ?! S∑0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S ∑0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑1..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑1..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S ∑I1..1stringPostal code for area
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S ∑1..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus S0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] S0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact S I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship S0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (required)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line S ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city S ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
..... postalCode S ∑I0..1stringPostal code for area
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S ∑0..1stringISO 3166 2 or 3 letter Country Code
Binding: ISO Country Codes (required)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider S0..*Reference(DAF-Organization | DAF-Pract)Patient's nominated primary care provider
... managingOrganization S ∑0..1Reference(DAF-Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

todo

This structure is derived from Patient.

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*Patient
... identifier S1..*Identifier
.... type S0..1CodeableConceptDescription of identifier
.... system S1..1uri
.... value S1..1stringThe value that is unique within the system.
... active S0..1boolean
... name S0..*HumanName
... telecom S0..*ContactPoint
.... system S1..1code
.... value S1..1string
.... use S0..1code
... gender S0..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... line S1..*string
.... city S1..1string
.... state S1..1stringBinding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S I1..1stringinv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S1..1string
... maritalStatus S0..1CodeableConcept
... multipleBirth[x] S0..1boolean, integer
... contact S0..*BackboneElement
.... relationship S0..*CodeableConceptBinding: PatientContactRelationship (required)
.... name S0..1HumanName
.... telecom S0..*ContactPoint
.... address S0..1Address
..... use S0..1code
..... line S0..*string
..... city S0..1string
..... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (required)
..... postalCode S I0..1stringinv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
..... country S0..1stringISO 3166 2 or 3 letter Country Code
Binding: ISO Country Codes (required)
... animal 0..0
... communication S0..*BackboneElement
.... language S1..1CodeableConcept
... careProvider S0..*Reference(DAF-Organization | DAF-Pract)
... managingOrganization S0..1Reference(DAF-Organization)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Slice: Unordered, Open, by url
Binding: MU Race Value Set (required)
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
... us-core-religion S0..1CodeableConceptPatient's professed religious affiliation
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-mothersMaidenName S0..1stringMother's Maiden name
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/birthPlace

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
... us-core-religion S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-religion
Binding: v3 Code System ReligiousAffiliation (extensible)
... patient-mothersMaidenName S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName
... birthPlace S0..1AddressExtension
URL: http://hl7.org/fhir/StructureDefinition/birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..*IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type S ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringThe value that is unique within the system.
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?! S∑0..1booleanWhether this patient's record is in active use
... name S ∑0..*HumanNameA name associated with the patient
... telecom S ∑0..*ContactPointA contact detail for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S ∑I1..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! S∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ∑0..1PeriodTime period when the contact point was/is in use
... gender S ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S ∑0..1dateThe date of birth for the individual
... deceased[x] ?! S∑0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S ∑0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! ∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑1..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑1..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑1..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
.... postalCode S ∑I1..1stringPostal code for area
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S ∑1..1stringCountry (can be ISO 3166 3 letter code)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus S0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (required)
... multipleBirth[x] S0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact S I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship S0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (required)
.... name S0..1HumanNameA name associated with the contact person
.... telecom S0..*ContactPointA contact detail for the person
.... address S0..1AddressAddress for the contact person
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
..... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
..... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
..... line S ∑0..*stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
..... city S ∑0..1stringName of city, town etc.
Example: Erewhon
..... district ∑0..1stringDistrict name (aka county)
Example: Madison
..... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (required)
..... postalCode S ∑I0..1stringPostal code for area
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
..... country S ∑0..1stringISO 3166 2 or 3 letter Country Code
Binding: ISO Country Codes (required)
..... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication S0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language S1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider S0..*Reference(DAF-Organization | DAF-Pract)Patient's nominated primary care provider
... managingOrganization S ∑0..1Reference(DAF-Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.17.1.2 Terminology Bindings

PathNameConformanceValueSet
Patient.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-race]]		MU Race Value SetrequiredMU Race Value Set
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-ethnicity]]		Ethnicity grouprequiredEthnicity group
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-religion]]		v3 Code System ReligiousAffiliationextensiblev3 Code System ReligiousAffiliation
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Patient.telecom.systemContactPointSystemrequiredContactPointSystem
Patient.telecom.useContactPointUserequiredContactPointUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationshipPatientContactRelationshiprequiredPatientContactRelationship
Patient.contact.address.useAddressUserequiredAddressUse
Patient.contact.address.typeAddressTyperequiredAddressType
Patient.contact.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Patient.contact.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

D.17.1.3 Constraints

IdPathDetailsRequirements
inv-1Patient.address.postalCode(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
pat-1Patient.contactSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
inv-2Patient.contact.address.postalCode(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.